Public Class VSIDwriter

Properties Detail

• DocumentationDirectory (Get)

  Public Property Get DocumentationDirectory As String
  Target Directory wherein API documentation documentation should be written.

• isUpdatingFrameset (Get)

  Public Property Get isUpdatingFrameset As Boolean
  Flag indicating if the API documentation Frameset is being updated

• ScriptDirectory (Get)

  Public Property Get ScriptDirectory As String
  Target Directory wherein Script source files should be written.

• DocumentationDirectory (Set)

  Public Property Set DocumentationDirectory As String
  Target Directory wherein API documentation documentation should be written.

• ScriptDirectory (Set)

  Public Property Set ScriptDirectory As String
  Target Directory wherein Script source files should be written.

Methods Detail

• createCodeElementFilepath

  Public Function createCodeElementFilepath(source As CodeElement, includesource As Boolean) As String
  Creates a Filepath for a CodeElement Concatenates the TargetFolder and the CodeElement's Parent Hierarchy to compute the filepath
  idx	Argument	Data Type	Attributes	Comments
  1	source	CodeElement		CodeElement object from which to create the filepath
  2	includesource	Boolean		Flag indicating if the source CodeElement's FileNameBase should be included in the filepath
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if source CodeElement is Nothing
  MSG_OPERATION_FAILED	1000	if the Filepath cannot be created.

• getAPIdoc_MajorElement

  Public Function getAPIdoc_MajorElement(source As MajorElement, writeMajorElements As Boolean) As StringQueue
  Gets the API documentation content for a MajorElement instance. Conditionally writes API documentation for Classes of the MajorElement
  idx	Argument	Data Type	Attributes	Comments
  1	source	MajorElement		MajorElement object for which to write the documentation
  2	writeMajorElements	Boolean		Flag indicating if API documentation for child MajorElements should be written

• getCodeElementFilepath

  Public Function getCodeElementFilepath(source As CodeElement, includesource As Boolean) As String
  Generates a Filepath for a CodeElement Concatenates the TargetFolder and the CodeElement's Parent Hierarchy to compute the filepath
  idx	Argument	Data Type	Attributes	Comments
  1	source	CodeElement		CodeElement object from which to create the filepath
  2	includesource	Boolean		Flag indicating if the source CodeElement's FileNameBase should be included in the filepath
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if source CodeElement is Nothing

• getCodeElementResourcePath

  Public Function getCodeElementResourcePath(soure As CodeElement) As String
  Generates a relative filepath to the resources folder for a CodeElement Creates a ../.. pattern as as appropriate for the CodeElement's Parent Hierarchy
  idx	Argument	Data Type	Attributes	Comments
  1	soure	CodeElement		CodeElement object from which to create the resource relative filepath
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if source CodeElement is Nothing

• getCodeElementRootPath

  Public Function getCodeElementRootPath(source As CodeElement) As String
  Generates a relative filepath to the root API documentation folder for a CodeElement Creates a ../.. pattern as as appropriate for the CodeElement's Parent Hierarchy
  idx	Argument	Data Type	Attributes	Comments
  1	source	CodeElement		CodeElement object from which to create the relative root filepath
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if source CodeElement is Nothing

• update_VSIDlist

  Public Function update_VSIDlist(source As VSID) As StringQueue
  Updates the API documentation vsid-list file
  idx	Argument	Data Type	Attributes	Comments
  1	source	VSID		API documentation VSID to be checked / added to the vsid-list file The vsid-list file contains lines of formmated text, with each line representing a VSID FORMAT: FQN|FileNameBase|Label
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if source VSID is Nothing

• writeAPIdoc_Container

  Public Function writeAPIdoc_Container(container As Variant) As StringQueue
  Writes API documentation html files for an array of BSX MajorElement Objects Valid object types are: VSID, VSE, Library, ObjectClass
  idx	Argument	Data Type	Attributes	Comments
  1	container	Variant		Array containing BSX objects for which to write the API documentation html files
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if VSIDwriter.DocumentationDirectory is blank

• writeAPIdoc_MajorElement

  Public Function writeAPIdoc_MajorElement(source As MajorElement) As String
  Writes the documentation for a MajorElement instance.
  idx	Argument	Data Type	Attributes	Comments
  1	source	MajorElement		MajorElement object for which to write the documentation
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if VSIDwriter.DocumentationDirectory is blank
  MSG_PARAMETER_BLANK	1199	if source MajorElement is Nothing

• writeAPIdoc_MajorElementsFiles

  Public Function writeAPIdoc_MajorElementsFiles(source As MajorElement) As StringQueue
  Updates the API documentation majorelements file The majorelements file contains lines of formmated text, with each line representing a MajorElement FORMAT: InstanceType|FQN|Relative Filepath|Label
  idx	Argument	Data Type	Attributes	Comments
  1	source	MajorElement		API documentation MajorElement whose content MajorElements information should be written to the majorelements file.
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if source MajorElement is Nothing

• writeAPIdoc_VSID

  Public Function writeAPIdoc_VSID(source As VSID) As String
  Writes the documentation for a VSID instance.
  idx	Argument	Data Type	Attributes	Comments
  1	source	VSID		VSID object for which to write the documentation
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if VSIDwriter.DocumentationDirectory is blank
  MSG_PARAMETER_BLANK	1199	if source ObjectClass is Nothing

• New

  Public Sub New()

• updateBalidoc_Frameset

  Public Sub updateBalidoc_Frameset(source As VSID)
  Updates the API documentation Frameset Files
  idx	Argument	Data Type	Attributes	Comments
  1	source	VSID		API documentation VSID to be checked / added to the vsid-list file
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if source VSID is Nothing

• writeAPIdoc_MajorElementsFrameHTML

  Public Sub writeAPIdoc_MajorElementsFrameHTML()
  Writes the API documentation Nav-Content-Frame HTML file.

• writeAPIdoc_OverviewFrameHTML

  Public Sub writeAPIdoc_OverviewFrameHTML(source As MajorElement)
  Writes the API documentation OverView Frame HTML file. The vsid-list file contains lines of formmated text, with each line representing a VSID FORMAT: FQN|Relative Filepath|Label
  idx	Argument	Data Type	Attributes	Comments
  1	source	MajorElement		VSID information for all current API documentation VSIDs

• writeAPIdoc_OverviewSummaryHTML

  Public Sub writeAPIdoc_OverviewSummaryHTML(source As StringQueue)
  Writes the API documentation OverView Summary HTML file. The vsid-list file contains lines of formmated text, with each line representing a VSID FORMAT: FQN|Relative Filepath|Label
  idx	Argument	Data Type	Attributes	Comments
  1	source	StringQueue		StringQueue containing the VSID information for all current API documentation VSIDs

• writeAPIdoc_VSIDFrameHTML

  Public Sub writeAPIdoc_VSIDFrameHTML(source As VSID)
  Writes the API documentation vsid-frame.html file for the specific VSID
  idx	Argument	Data Type	Attributes	Comments
  1	source	VSID		API documentation VSID for which to write the vsid-frame.html file
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if source VSID is Nothing

• write_IndexHTML

  Public Sub write_IndexHTML()
  Writes the API documentation index.html file